<!-- HTML header for doxygen 1.8.12-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pymoduleconnector: pymoduleconnector.extras.regmap.RegBlock Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <!-- Platform title -->
    <div class="page-title-bar container-fluid">
      <div id="projectalign" class="row">
        <div id="projectname" class="col-sm-12">pymoduleconnector
          &#160;<span id="projectnumber">1.6.2</span>
        </div>
        <div id="projectbrief" class="col-sm-12">A Python wrapper for XeThru ModuleConnector</div>
      </div>
    </div>
    <div class="topbar">
      <div class="container">
        <div id="titlearea">
          <div class="xethru-logo">
            <img src="xethru-logo_220x55HD.png" alt="Novelda XeThru web site" id="logo-image" />
          </div>
        </div>
        <!-- end header part -->
        <!-- Generated by Doxygen 1.8.12 -->
        <!--BEGIN MAIN-NAV AND SEARCHENGINE-->
        <div id="main-nav"></div>
        <!--END MAIN-NAV AND SEARCHENGINE-->
      </div>
    </div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>pymoduleconnector</b></li><li class="navelem"><b>extras</b></li><li class="navelem"><b>regmap</b></li><li class="navelem"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml">RegBlock</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pymoduleconnector.extras.regmap.RegBlock Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml" title="The RegBlock class encapsulates one or more RegMap objects (register maps). ">RegBlock</a> class encapsulates one or more <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml">RegMap</a> objects (register maps).  
 <a href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9af23de852d0bd1fd8092dbb0b6733f1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a9af23de852d0bd1fd8092dbb0b6733f1">__init__</a> (self, radar, configfile_section_name=&quot;registers&quot;)</td></tr>
<tr class="memdesc:a9af23de852d0bd1fd8092dbb0b6733f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml" title="The RegBlock class encapsulates one or more RegMap objects (register maps). ">RegBlock</a> object.  <a href="#a9af23de852d0bd1fd8092dbb0b6733f1">More...</a><br /></td></tr>
<tr class="separator:a9af23de852d0bd1fd8092dbb0b6733f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54be27782c7eeed8020add4f7225ff58"><td class="memItemLeft" align="right" valign="top"><a id="a54be27782c7eeed8020add4f7225ff58"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a54be27782c7eeed8020add4f7225ff58">set_use_shadow</a> (self, use_shadow=False)</td></tr>
<tr class="memdesc:a54be27782c7eeed8020add4f7225ff58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set use_shadow on each register. <br /></td></tr>
<tr class="separator:a54be27782c7eeed8020add4f7225ff58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adaa529524b3e92b721c3f5a7c25c67c6"><td class="memItemLeft" align="right" valign="top"><a id="adaa529524b3e92b721c3f5a7c25c67c6"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#adaa529524b3e92b721c3f5a7c25c67c6">refresh_shadow</a> (self)</td></tr>
<tr class="memdesc:adaa529524b3e92b721c3f5a7c25c67c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh local shadow of all maps. <br /></td></tr>
<tr class="separator:adaa529524b3e92b721c3f5a7c25c67c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9861081de4fccbee0246d90b33f486b"><td class="memItemLeft" align="right" valign="top"><a id="ac9861081de4fccbee0246d90b33f486b"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#ac9861081de4fccbee0246d90b33f486b">load_config</a> (self, configfile=None)</td></tr>
<tr class="memdesc:ac9861081de4fccbee0246d90b33f486b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load register configuration from an ini-file. <br /></td></tr>
<tr class="separator:ac9861081de4fccbee0246d90b33f486b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfc97bed854eaa0fe1e3344badd5a65b"><td class="memItemLeft" align="right" valign="top"><a id="abfc97bed854eaa0fe1e3344badd5a65b"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#abfc97bed854eaa0fe1e3344badd5a65b">write_config</a> (self, configfile=&quot;config.ini&quot;)</td></tr>
<tr class="memdesc:abfc97bed854eaa0fe1e3344badd5a65b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write current register configuration to an ini-file. <br /></td></tr>
<tr class="separator:abfc97bed854eaa0fe1e3344badd5a65b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d99e45dfc4f913609ea461bf8f3381c"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a3d99e45dfc4f913609ea461bf8f3381c">__add_map__</a> (self, map)</td></tr>
<tr class="memdesc:a3d99e45dfc4f913609ea461bf8f3381c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a register map to the register block.  <a href="#a3d99e45dfc4f913609ea461bf8f3381c">More...</a><br /></td></tr>
<tr class="separator:a3d99e45dfc4f913609ea461bf8f3381c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a192343e00b8f8856b1b394551c674428"><td class="memItemLeft" align="right" valign="top"><a id="a192343e00b8f8856b1b394551c674428"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a192343e00b8f8856b1b394551c674428">__iter__</a> (self)</td></tr>
<tr class="memdesc:a192343e00b8f8856b1b394551c674428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable iteration through registers. <br /></td></tr>
<tr class="separator:a192343e00b8f8856b1b394551c674428"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c5f629bfd7d78ad1d08960b4cd71dbf"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a6c5f629bfd7d78ad1d08960b4cd71dbf">__getitem__</a> (self, seg)</td></tr>
<tr class="memdesc:a6c5f629bfd7d78ad1d08960b4cd71dbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emulate dict behavior.  <a href="#a6c5f629bfd7d78ad1d08960b4cd71dbf">More...</a><br /></td></tr>
<tr class="separator:a6c5f629bfd7d78ad1d08960b4cd71dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6690d29e2f853dbce1c3940ba78de543"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml#a6690d29e2f853dbce1c3940ba78de543">__setitem__</a> (self, seg, value)</td></tr>
<tr class="memdesc:a6690d29e2f853dbce1c3940ba78de543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emulate dict behavior.  <a href="#a6690d29e2f853dbce1c3940ba78de543">More...</a><br /></td></tr>
<tr class="separator:a6690d29e2f853dbce1c3940ba78de543"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45a6256d6e57c83ffff38c02ece674dd"><td class="memItemLeft" align="right" valign="top"><a id="a45a6256d6e57c83ffff38c02ece674dd"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__setattr__</b> (self, name, value)</td></tr>
<tr class="separator:a45a6256d6e57c83ffff38c02ece674dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml" title="The RegBlock class encapsulates one or more RegMap objects (register maps). ">RegBlock</a> class encapsulates one or more <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml">RegMap</a> objects (register maps). </p>
<p>This class is intended to be sub-classed for specific chips or chip versions. The sub-class will overload the <b>init</b> function and call the <b>add_map</b> function for each register map that is part of the register block. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9af23de852d0bd1fd8092dbb0b6733f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9af23de852d0bd1fd8092dbb0b6733f1">&sect;&nbsp;</a></span>__init__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegBlock.__init__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>radar</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>configfile_section_name</em> = <code>&quot;registers&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a new <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_block.xhtml" title="The RegBlock class encapsulates one or more RegMap objects (register maps). ">RegBlock</a> object. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3d99e45dfc4f913609ea461bf8f3381c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d99e45dfc4f913609ea461bf8f3381c">&sect;&nbsp;</a></span>__add_map__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegBlock.__add_map__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>map</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a register map to the register block. </p>
<p>The provided <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml">RegMap</a> object is added to the register block.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">map</td><td>The <a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml">RegMap</a> object to be added </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a6c5f629bfd7d78ad1d08960b4cd71dbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c5f629bfd7d78ad1d08960b4cd71dbf">&sect;&nbsp;</a></span>__getitem__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegBlock.__getitem__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>seg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Emulate dict behavior. </p>
<p>Gives access to register segments as regblock[segment]. </p>

</div>
</div>
<a id="a6690d29e2f853dbce1c3940ba78de543"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6690d29e2f853dbce1c3940ba78de543">&sect;&nbsp;</a></span>__setitem__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegBlock.__setitem__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>seg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Emulate dict behavior. </p>
<p>Gives access to register segments as regblock[segment]. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pymoduleconnector/extras/regmap.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<hr class="footer"/>
 <address class="footer">
 Copyright &copy; 2016 Novelda AS - <a href="http://www.xethru.com">www.xehtru.com</a><br />
 <small>
  Generated by &#160;<a href="http://www.doxygen.org/index.html">
  <img class="footer" src="doxygen.png" alt="doxygen"/>
  </a> 1.8.12
 </small>
 </address>
</body>
</html>
